home *** CD-ROM | disk | FTP | other *** search
/ Total Network Tools 2002 / NextStepPublishing-TotalNetworkTools2002-Win95.iso / Archive / Misc Servers / Zope.exe / HELPSYS.PY < prev    next >
Encoding:
Python Source  |  2000-11-27  |  11.6 KB  |  338 lines
  1. ##############################################################################
  2. # 
  3. # Zope Public License (ZPL) Version 1.0
  4. # -------------------------------------
  5. # 
  6. # Copyright (c) Digital Creations.  All rights reserved.
  7. # 
  8. # This license has been certified as Open Source(tm).
  9. # 
  10. # Redistribution and use in source and binary forms, with or without
  11. # modification, are permitted provided that the following conditions are
  12. # met:
  13. # 
  14. # 1. Redistributions in source code must retain the above copyright
  15. #    notice, this list of conditions, and the following disclaimer.
  16. # 
  17. # 2. Redistributions in binary form must reproduce the above copyright
  18. #    notice, this list of conditions, and the following disclaimer in
  19. #    the documentation and/or other materials provided with the
  20. #    distribution.
  21. # 
  22. # 3. Digital Creations requests that attribution be given to Zope
  23. #    in any manner possible. Zope includes a "Powered by Zope"
  24. #    button that is installed by default. While it is not a license
  25. #    violation to remove this button, it is requested that the
  26. #    attribution remain. A significant investment has been put
  27. #    into Zope, and this effort will continue if the Zope community
  28. #    continues to grow. This is one way to assure that growth.
  29. # 
  30. # 4. All advertising materials and documentation mentioning
  31. #    features derived from or use of this software must display
  32. #    the following acknowledgement:
  33. # 
  34. #      "This product includes software developed by Digital Creations
  35. #      for use in the Z Object Publishing Environment
  36. #      (http://www.zope.org/)."
  37. # 
  38. #    In the event that the product being advertised includes an
  39. #    intact Zope distribution (with copyright and license included)
  40. #    then this clause is waived.
  41. # 
  42. # 5. Names associated with Zope or Digital Creations must not be used to
  43. #    endorse or promote products derived from this software without
  44. #    prior written permission from Digital Creations.
  45. # 
  46. # 6. Modified redistributions of any form whatsoever must retain
  47. #    the following acknowledgment:
  48. # 
  49. #      "This product includes software developed by Digital Creations
  50. #      for use in the Z Object Publishing Environment
  51. #      (http://www.zope.org/)."
  52. # 
  53. #    Intact (re-)distributions of any official Zope release do not
  54. #    require an external acknowledgement.
  55. # 
  56. # 7. Modifications are encouraged but must be packaged separately as
  57. #    patches to official Zope releases.  Distributions that do not
  58. #    clearly separate the patches from the original work must be clearly
  59. #    labeled as unofficial distributions.  Modifications which do not
  60. #    carry the name Zope may be packaged in any form, as long as they
  61. #    conform to all of the clauses above.
  62. # 
  63. # 
  64. # Disclaimer
  65. # 
  66. #   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
  67. #   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  68. #   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  69. #   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
  70. #   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  71. #   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  72. #   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  73. #   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  74. #   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  75. #   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  76. #   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  77. #   SUCH DAMAGE.
  78. # 
  79. # 
  80. # This software consists of contributions made by Digital Creations and
  81. # many individuals on behalf of Digital Creations.  Specific
  82. # attributions are listed in the accompanying credits file.
  83. # 
  84. ##############################################################################
  85.  
  86. import Acquisition
  87. from OFS.SimpleItem import Item
  88. from OFS.ObjectManager import ObjectManager
  89. from Globals import Persistent, HTMLFile, HTML
  90. from Products.ZCatalog.ZCatalog import ZCatalog
  91. from Products.ZCatalog.Lazy import LazyCat
  92. import Products
  93. import HelpTopic
  94. import Globals
  95.  
  96. class HelpSys(Acquisition.Implicit, ObjectManager, Item, Persistent):
  97.     """
  98.     Zope Help System
  99.     
  100.     Provides browsing and searching of Zope Product Help.
  101.     """
  102.     meta_type='Help System'
  103.  
  104.     manage_options=(
  105.         {'label' : 'Contents', 'action' : 'menu'},
  106.         {'label' : 'Search', 'action' : 'search'},
  107.     )
  108.  
  109.     __ac_permissions__=(
  110.         ('View',
  111.          ('__call__', 'searchResults', 'HelpButton', '',
  112.           'index_html', 'menu', 'search', 'results', 'main', )),
  113.         ('Access contents information', ('helpValues',)),
  114.         )
  115.  
  116.     def __init__(self, id='HelpSys'):
  117.         self.id=id
  118.  
  119.     def helpValues(self, spec=None):
  120.         "ProductHelp objects of all Products that have help"
  121.         hv=[]
  122.         for product in self.Control_Panel.Products.objectValues():
  123.             productHelp=product.getProductHelp()
  124.             # only list products that actually have help
  125.             if productHelp.helpValues():
  126.                 hv.append(productHelp)
  127.         return hv
  128.  
  129.     # Seaching does an aggregated search of all ProductHelp
  130.     # objects. Only Help Topics for which the user has permissions
  131.     # are returned.
  132.     def __call__(self, REQUEST=None, **kw):
  133.         "Searchable interface"
  134.         if REQUEST is not None:
  135.             perms=[]
  136.             user=REQUEST.AUTHENTICATED_USER
  137.             for p in self.ac_inherited_permissions():
  138.                 if user.has_permission(p[0], self):
  139.                     perms.append(p[0])
  140.             REQUEST.set('permissions',perms)
  141.         results=[]
  142.         for ph in self.helpValues():
  143.             results.append(apply(getattr(ph, '__call__'), (REQUEST,) , kw))
  144.         return LazyCat(results)   
  145.         
  146.     searchResults=__call__
  147.     
  148.     index_html=HTMLFile('frame', globals())
  149.     menu=HTMLFile('menu', globals())
  150.     search=HTMLFile('search', globals())
  151.     results=HTMLFile('results', globals())
  152.     main=HTML("""<html></html>""")
  153.     standard_html_header=HTMLFile('menu_header', globals())
  154.     standard_html_footer=HTMLFile('menu_footer', globals())
  155.  
  156.     button=HTMLFile('button', globals())
  157.  
  158.     def HelpButton(self, topic, product):
  159.         """
  160.         Insert a help button linked to a help topic.
  161.         """
  162.         return self.button(self, self.REQUEST, product=product, topic=topic)
  163.  
  164.     helpURL=HTMLFile('helpURL',globals())
  165.  
  166.  
  167.     def tpValues(self):
  168.         """
  169.         Tree protocol - returns child nodes
  170.  
  171.         Aggregates Product Helps with the same title.
  172.         """
  173.         helps={}
  174.         for help in self.helpValues():
  175.             if helps.has_key(help.title):
  176.                 helps[help.title].append(help)
  177.             else:
  178.                 helps[help.title]=[help]
  179.         cols=[]
  180.         for k,v in helps.items():
  181.             cols.append(TreeCollection(k,v,0))
  182.         return cols
  183.  
  184. Globals.default__class_init__(HelpSys)
  185.  
  186.  
  187. class TreeCollection:
  188.     """
  189.     A temporary wrapper for a collection of objects
  190.     objects, used for help topic browsing to make a collection
  191.     of objects appear as a single object.
  192.     """
  193.  
  194.     def __init__(self, id, objs, simple=1):
  195.         self.id=self.title=id
  196.         self.objs=objs
  197.         self.simple=simple
  198.         
  199.     def tpValues(self):
  200.         values=[]
  201.         if self.simple:
  202.             values=self.objs
  203.         else:
  204.             for obj in self.objs:
  205.                 values=values + list(obj.tpValues())
  206.         # resolve overlap
  207.         ids={}
  208.         for value in values:
  209.             if ids.has_key(value.id):
  210.                 ids[value.id].append(value)
  211.             else:
  212.                 ids[value.id]=[value]
  213.         results=[]
  214.         for k,v in ids.items():
  215.             if len(v)==1:
  216.                 results.append(v[0])
  217.             else:
  218.                 values=[]
  219.                 for topic in v:
  220.                     values=values + list(topic.tpValues())
  221.                 results.append(TreeCollection(k, values)) 
  222.         results.sort(lambda x, y: cmp(x.id, y.id))
  223.         return results
  224.  
  225.     def tpId(self):
  226.         return self.id
  227.  
  228.  
  229. class ProductHelp(Acquisition.Implicit, ObjectManager, Item, Persistent):
  230.     """
  231.     Manages a collection of Help Topics for a given Product.
  232.     
  233.     Provides searching services to HelpSystem.
  234.     """
  235.  
  236.     meta_type='Product Help'
  237.     icon='p_/ProductHelp_icon'
  238.  
  239.     lastRegistered=None
  240.     
  241.     meta_types=({'name':'Help Topic',
  242.                  'action':'addTopicForm',
  243.                  'permission':'Add Documents, Images, and Files'},
  244.                 )
  245.  
  246.     manage_options=(
  247.         ObjectManager.manage_options +
  248.         Item.manage_options
  249.         )
  250.  
  251.     __ac_permissions__=(
  252.         ('Add Documents, Images, and Files', ('addTopicForm', 'addTopic')),
  253.         )
  254.     
  255.     def __init__(self, id='Help', title=''):
  256.         self.id=id
  257.         self.title=title
  258.         self.catalog=ZCatalog('catalog')
  259.         c=self.catalog._catalog
  260.         # clear catalog
  261.         for index in c.indexes.keys():
  262.             c.delIndex(index)
  263.         for col in c.schema.keys():
  264.             c.delColumn(col)
  265.         c.addIndex('SearchableText', 'TextIndex')
  266.         c.addIndex('categories', 'KeywordIndex')
  267.         c.addIndex('permissions', 'KeywordIndex')
  268.         c.addColumn('categories')
  269.         c.addColumn('permissions')
  270.         c.addColumn('title_or_id')
  271.         c.addColumn('url')
  272.         c.addColumn('id')
  273.  
  274.     addTopicForm=HTMLFile('addTopic', globals())
  275.  
  276.     def addTopic(self, id, title, REQUEST=None):
  277.         "Add a Help Topic"
  278.         topic=HelpTopic.DTMLDocumentTopic(
  279.             HelpTopic.default_topic_content, __name__=id)
  280.         topic.title=title
  281.         self._setObject(id, topic)
  282.         if REQUEST is not None:
  283.             return self.manage_main(self, REQUEST,
  284.                                     manage_tabs_message='Help Topic added.')
  285.  
  286.     def helpValues(self, REQUEST=None):
  287.         """
  288.         Lists contained Help Topics.
  289.         Help Topics for which the user is not authorized
  290.         are not listed.
  291.         """
  292.         topics=self.objectValues('Help Topic')
  293.         if REQUEST is None:
  294.             return topics
  295.         return filter(
  296.             lambda ht, u=REQUEST.AUTHENTICATED_USER: ht.authorized(u), topics)
  297.  
  298.     def tpValues(self):
  299.         """
  300.         Tree protocol - child nodes
  301.         """
  302.         topics=[]
  303.         apitopics=[]
  304.         dtmltopics=[]
  305.         for topic in self.objectValues('Help Topic'):
  306.             if hasattr(topic,'isAPIHelpTopic') and topic.isAPIHelpTopic:
  307.                 apitopics.append(topic)
  308.             else:
  309.                 if callable(topic.id):
  310.                     id=topic.id()
  311.                 else:
  312.                     id=topic.id
  313.                 if id[:5]=='dtml-':
  314.                     dtmltopics.append(topic)
  315.                 else:
  316.                     topics.append(topic)
  317.         if dtmltopics:
  318.             topics = topics + [TreeCollection(' DTML Reference', dtmltopics)]
  319.         if apitopics:
  320.             topics = topics + [TreeCollection(' API Reference', apitopics)]
  321.         return topics
  322.         
  323.     def all_meta_types(self):
  324.         f=lambda x: x['name'] in ('Image', 'File')
  325.         return filter(f, Products.meta_types) + self.meta_types
  326.  
  327.     def __call__(self, *args, **kw):
  328.         """
  329.         Searchable interface
  330.         """
  331.         return apply(self.catalog.__call__, args, kw)
  332.  
  333.     standard_html_header=HTMLFile('topic_header', globals())
  334.     standard_html_footer=HTMLFile('topic_footer', globals())
  335.  
  336.  
  337. Globals.default__class_init__(ProductHelp)
  338.